@interopio/browser API Reference

Properties (20)

Property Type Default Required Description
appId⚓︎ string x

The unique application identifier located within a specific application directory instance.
categories⚓︎ string[] x x

An array of string categories that describe the application. These are meant as a hint to catalogs or stores listing FDC3-enabled apps and it is expected that these will make a best effort to find appropriate categories (or category) under which to list the app.
contactEmail⚓︎ string x x

Optional e-mail to receive queries about the application
customConfig⚓︎ PropertiesObject[] x x

An optional set of name value pairs that can be used to deliver custom data from an App Directory to a launcher
description⚓︎ string x x

Description of the application. This will typically be a 1-2 paragraph style blurb about the application.
details⚓︎ { url: string; } x

The type specific launch details of the application. These details are intended to be vendor-agnostic and MAY be duplicated or overridden by details provided in the hostManifests object for a specific host.
hostManifests⚓︎ any x x

A mapping from host name to a host-specific application manifest object or URI from which that manifest can be retrieved. The manifest should provide details required to launch and use the application within the specified host. The manifest MAY duplicate or override information provided in the details field.
icons⚓︎ IconV2[] x x

Holds Icons used for the application, a Launcher may be able to use multiple Icon sizes or there may be a 'button' Icon
interop⚓︎ InteropV2 x x

Metadata that describes how the application uses FDC3 APIs. This metadata serves multiple purposes:

  • It supports intent resolution by a desktop agent, by declaring what intents an app listens for.
  • It may be used, for example in an app catalog UI, to find apps that 'interoperate with' other apps.\
  • It provides a standard location to document how the app interacts with user channels, app channels, and intents, for use by other app developers and desktop assemblers.
lang⚓︎ string x x

A language tag that specifies the primary language of both the application and its AppD entry, as defined by IETF RFC 5646.
localizedVersions⚓︎ { [languageTag: string]: LocalizedVersionDefinition } x x

Provides localized alternatives to any field of the AppD record, which may also refer to an alternative version of the application that is also localized (e.g. by providing an alternative URL). The keys to this object should be language tags as defined by IETF RFC 5646, e.g. en, en-GB or fr-FR.
moreInfo⚓︎ string x x

Optional URL that provides more information about the application
name⚓︎ string x x

The name of the application. The name should be unique within an FDC3 App Directory instance. The exception to the uniqueness constraint is that an App Directory can hold definitions for multiple versions of the same app. The same appName could occur in other directories. We are not currently specifying app name conventions in the document.
publisher⚓︎ string x x

The name of the company that owns the application. The publisher has control over their namespace/app/signature.
screenshots⚓︎ ImageV2[] x x

Array of images to show the user when they are looking at app description. Each image can have an optional description/tooltip
supportEmail⚓︎ string x x

Optional e-mail to receive support requests for the application
title⚓︎ string x x

Optional title for the application, if missing use appName, typically used in a launcher UI.
tooltip⚓︎ string x x

Optional tooltip description e.g. for a launcher
type⚓︎ FDC3DefinitionV2Types x

Enum: "web" "native" "citrix" "onlineNative" "other". The technology type that is used to launch and run the application. Each application type implies a particular set of launch details
version⚓︎ string x x

Version of the application. This allows multiple app versions to be defined using the same app name. This can be a triplet but can also include things like 1.2.5 (BETA)